home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr29 / tdb005i.zip / TELDOR.DOC < prev    next >
Text File  |  1995-02-17  |  16KB  |  295 lines
  1. Documentation for Telnet Door version 0.05i, the universal interface between an
  2. OS/2 BBS and the Internet.
  3.  
  4.   Telnet Door is a program that I initially wrote because I wanted to connect
  5. my BBS to the Internet via a UNIX system.  I wrote this door to enable users
  6. of my system to login to my UNIX system via OS/2s TCP/IP networking, and from
  7. access the Internet from there (once I get a connection).  I soon realised that
  8. many other sysops want to do the same thing, so I decided to release this as
  9. shareware.
  10.  
  11.  
  12. +++Shareware legal statement:
  13.  
  14.    This program is not guaranteed to do anything apart from consume space on
  15. your hard drive.  If you wish to use this program for more than 30 days from
  16. the date you received it you must register it (see TELDOR.REG for details).
  17.  
  18. +++System requirements:
  19.  
  20.    This program requires at least OS/2 version 2.0 running IBM's TCP/IP
  21. networking software version 2.0 (I believe that my program is compatible with
  22. FTP software's TCP/IP for OS/2, but I haven't been able to test it).
  23. Requirements for RAM and hard drive space are so small that it won't make an
  24. impact on the typical BBS system.
  25.  
  26. +++Test system:
  27.  
  28.    This program has been extensively tested on an OS/2 system running OS/2 Warp
  29. version 3.00 with the Internet Access Kit running on an Ethernet network with
  30. MPTN (the IAK won't run on a LAN without MPTN nee LAPS) on a 486.  The target
  31. systems of the TELNET were a 386 running Linux (kernel versions 1.1.61 to
  32. 1.1.85 and utilities from the Slackware 2.0.0 distribution).
  33.  
  34. +++Compiler used:
  35.  
  36.    This program was compiled with IBM's Cset++ version 2.1.
  37.  
  38. +++Usage of Telnet Door:
  39.  
  40.    Here's the help screen which is displayed when you give it incorrect command
  41. line parameters, no command line arguements or run it with the "-?" parameter:
  42.  
  43.  
  44. Registered to Russell Coker of Multi BBS for 16 nodes.
  45. Serial number:1.
  46.  
  47. Usage: teldor [ OPTIONS ] A=host address
  48.  
  49. hostname is in dotted decimal or *domain name* convention
  50.  
  51. Options: h=file handle       file handle of open serial port passed from
  52.                              external program
  53.          c=com port          device name for serial port
  54.          fd=door config file full file and path name for DORINFO1.DEF file
  55.          t=mins              time in minutes that the user may be logged in
  56.          d=filename          debugging file name
  57.          l=filename          logging file name
  58.          p=port              TCP port/service to login to on remote machine
  59.          o=options           misc on/off options, see manual
  60.  
  61. If multiple hostnames are entered then a menu will be displayed.
  62. Telnet Door V0.05i WIDE BETA, copyright 1995 Russell Coker.
  63.  
  64.  
  65.    Basic usage is "teldor A=202.12.87.129" or "teldor A=snoopy.apana.org.au"
  66. or whatever the destination address is using either the dotted decimal address
  67. or the domain name system address to just TELNET in to the host system.  The
  68. "A=" command is used to specify the address to connect to.
  69.    NB  These examples use the internet address of my UNIX box.  If you actually
  70. use this address you should be able to connnect to that system.  However I
  71. don't currently have a guest account set up (so you won't be able to log in).
  72.  
  73.  
  74.   For basic BBS operation it is:
  75.     "teldor fd=c:\path\dorinfo1.def A=202.12.87.129"
  76.  
  77. The 'fd' parameter specifies the fully qualified path name of the DORINFO1.DEF
  78. file which contains all necessary information on the user.  The 'f' stands for
  79. the file name of a settings file, and the 'd' stands for DORINFO1.DEF format.
  80. In future I will support other formats as well.  NB  The "COMx" line in the
  81. door file is taken to contain the number of the open OS/2 file handle for the
  82. serial port.  So "COM3" does not mean serial port 3 it means file handle 3
  83. which points to a serial port.  If you don't understand this then read the
  84. documentation for Maximus or BinkleyTerm.  I don't agree with that feature
  85. being used in that way, but I know 99% of you have BBSs set up like that.  The
  86. preferred way of passing an open serial port handle is via the "H=x" command
  87. line parameter which overrides the parameter in the door file (all command
  88. line parameters take precedence over door file parameters).
  89.    If you want Telnet Door to open the serial port (EG when called from a DOS
  90. BBS) then use the option "c=COMn" where 'n' is the number of the serial port
  91. to use.  This option will cause Telnet Door to open the serial port and
  92. initialise it before doing anything else.
  93.    NB You generally should not call it that way from an OS/2 BBS package.  The
  94. preferred way is via the "H=handle" parameter.
  95.  
  96.    This program will exit if a user tries to stay online longer than they are
  97. allowed.  It does not hang up on them, it merely tells them that their time
  98. is up and exits.  This allows the BBS software to decide exactly what to do
  99. when someone stays online too long.  The amount of time that they are allowed
  100. is taken from the command line via the "t=x" parameter, or from the door file
  101. if it's not specified on the command line (NB the doorfile is strictly
  102. optional, if you don't specify a time limit on the command line and the
  103. doorfile isn't being used then they are allowed to stay online forever).  The
  104. user is given a warning 5 minutes before their time is due to expire to give
  105. them time to save files etc.
  106.  
  107.     The "P=x" command line parameter is used to specify the TCP port to login
  108. to on the remote machine.  The default is 23 (the RLOGIN port).  You can also
  109. use a service name with the "p=" parameter.  EG  "p=nntp" would connect you to
  110. the Net News Transfer Protocol port and allow you to read Net News (if you're
  111. masochistic).
  112.  
  113.     The parameters "D=" and "L=" are for specifying the debugging and logging
  114. file names respectively.  The logging file will store all data sent to the
  115. user on disk and may be useful to a sysop.  The debugging file will only store
  116. information on the state of my program.  The intended usage of the debugging
  117. file is for you to send it to me if you encounter a bug in my program, however
  118. if you feel curious then feel free to try and decipher it.
  119.  
  120.    The "O=" command line parameter can be used in the following ways:
  121.     "O=C" will turn the local console off.  This is useful for BBS sysops who
  122. don't want to see what the user is doing.  It turns off all local display and
  123. bkeyboard input.  This can make TELDOR run considerably faster in some
  124. situations due to the output speed slowing the system down, a future version
  125. will display output much faster and this won't be needed for speed.
  126.     "O=7" will turn off binary mode.  This is necessary if you wish to login to
  127. an OS/2 system and not have the screen garbled.
  128.     "O=8" will force my program to pass binary data in both directions when not
  129. in binary mode!  It should never be necessary to use this feature, but I expect
  130. that there are some telnet servers out there that are buggy and require this.
  131.    "O=L" will tell Telnet Door to consider the serial port a "Lame" port.  This
  132. is useful when using something other than a standard serial port (eg a named
  133. pipe over a network, a serial port that has a badly written device driver, or
  134. some other interface that acts like a serial port but doesn't have the full
  135. capabilities).  It tells TelDor to not try changing serial port settings.  If
  136. Telnet Door doesn't run and you are using non-standard serial drivers then try
  137. using this option.
  138.     If you wish to have all data displayed locally except for BEL characters
  139. then the setting O=Q (for quiet) will cause all beeps to be filtered out from
  140. local display (they will still be sent to the remote user however).
  141.     You use multiple options in the following way "O=7C" to turn console output
  142. off and to use non-binary mode, or "O=8Q" to force binary transmission and
  143. filter out beeps from local display.
  144.    NB  The options "8" and "7" should be avoided if at all possible.  They
  145. should only be necessary for some buggy Telnet Daemons and you should not need
  146. to ever use them.  I have not seen a system that needs the "8" option, but I
  147. assumed that there would be one so I implemented the feature.  I regularly do
  148. transfers of binary data (including Zmodem file transfers) over Telnet Door
  149. without using the "8" option.  It is theoretically possible that use of the "8"
  150. option where it is not appropriate could cause problems resulting in a loss
  151. of the TELNET connection.
  152.  
  153.  
  154. +++Usage of APPLY.EXE:
  155.   The program APPLY.EXE is used to apply your registration key file (that you
  156. will receive after registering Telnet Door) to your system.  The command is
  157. simply "APPLY nnnnn.KEY" where "nnnnn" is the serial number of your key.  Do
  158. not delete your key file after running this program as you will need it in
  159. future.
  160.    Do not let anyone else receive a copy of your KEY file, distributing a KEY
  161. file is piracy (and it has your name in it so it will be well advertised
  162. piracy too).  If you believe that someone may have stolen a copy of your KEY
  163. file then contact me immidiately and I will cancel it as of the next release
  164. of Telnet Door.
  165.    When I send you your key file it will be in an LHArc archive which has a
  166. name based on your name, that archive will contain a file named nnnnn.KEY where
  167. nnnnn is the serial number of the key.  For example if I was sending myself a
  168. KEY file I would send an LHArc archive named RUSSELL.LZH containing a file
  169. named 1.KEY...
  170.  
  171.  
  172.  
  173. +++Environment considerations:
  174.  
  175.   This program is not particularly susceptible to changes in the CONFIG.SYS
  176. file, it should work fairly well no matter what settings you have in place.
  177. However there are some guidelines that may help you in setting up your system
  178. to get maximum performance.
  179.    If you are running many copies of Telnet Door you generally should not
  180. change the TIMESLICE parameter in CONFIG.SYS in an attempt to improve
  181. performance.  Some people may think that when running many copies of a program
  182. they will get faster user-response time by decreasing the size of a time
  183. slice - this is generally not true and definately not true for this program.
  184. Telnet Door spends most of it's time (99.9%) blocked on IO or sleeping, so
  185. when it is doing something (which will generally be of short duration) it is
  186. better if it is allowed to complete the operation before blocking on IO or
  187. sleeping again.  Otherwise CPU time will be wasted on excessive task switching
  188. and user response may be slowed down as a result.
  189.    If you are running Telnet Door on a system that also runs badly behaved
  190. applications (or DOS and Windows applications which are badly behaved by
  191. definition) then it may be necessary to use the MAXWAIT parameter in your
  192. CONFIG.SYS file to ensure that users of Telnet Door (and other BBS
  193. applications) get keyboard response in a reasonable amount of time.  It may
  194. be necessary to change this value to 2 or 1 to give users of your BBS an
  195. acceptable response time.  This will affect all programs not just Telnet Door
  196. so any setting that works well with your favourite OS/2 BBS package should
  197. work well with Telnet Door.
  198.   When you are running Telnet Door you must ensure that you have enough threads
  199. set in your CONFIG.SYS file.  Telnet Door requires 4 threads for modem
  200. operation when time-limits are enforced, and 2 threads for non-modem
  201. operation without time-limits, so a 16 line BBS could require up to 64 threads
  202. for Telnet Door alone!  Increasing the number of threads for the system has
  203. not been found to lower system performance so I recommend a minimum of 256
  204. threads for a typical BBS system.  More may be required depending on the
  205. number of lines and the amount of networking that is being performed.
  206.  
  207.  
  208. +++Error Levels:
  209.  
  210.   Telnet door will exit with the following error levels which you may want to
  211. use in batch files etc:
  212.  
  213. 0   Normal exit - no error.
  214.  
  215. 1   Command line error.
  216.  
  217. 2   Carrier loss.
  218.  
  219. 3   Socket error (crash of UNIX host?).
  220.  
  221. 4   Serial port error (connected to wrong serial port or another program is
  222.     interfering with the serial port).
  223.  
  224. 5   Display error - shouldn't happen.
  225.  
  226. 6   Keyboard error - shouldn't happen.
  227.  
  228. 255 Really serious or unplanned error, could be a bug in Telnet Door.  If this
  229.     happens then let me know.
  230.  
  231.  
  232.  
  233. +++Trial Usage Conditions:
  234.  You may use this program for 30 days before registering it.  During that time
  235. you will be limited to either running no more than 2 copies of Telnet Door
  236. concurrantly or to running 16 copies with a maximum time limit of 10 minutes
  237. for each login.  If you wish to use the 16 lines with 10 minutes option for the
  238. unregistered version of Telnet Door then you must use the command line option
  239. of "UNREGMODE=2".
  240.  After you have exceeded your trial usage period Telnet Door will display
  241. reminder messages to inform you that it is time to register.
  242.  
  243.  
  244.  
  245. +++Registering:
  246.  
  247.  To register post a cheque or International bank draft, or credit card payment
  248. program to the address listed in TELDOR.REG.  I accept payment by VisaCard,
  249. MasterCard, and BankCard from any country in the world through my agent
  250. Multifunction Computing.  If you pay me by credit card you will see the name
  251. Multifunction Computing on your next bank statement.
  252.   The file TELDOR.REG contains all information necessary to register this
  253. program including pricing information.
  254.  
  255.   The next full release of Telnet Door will require a key file to provide full
  256. functionality.  Make sure you send me your EMAIL address when you register so
  257. I can send you your key.
  258.  
  259.  
  260.    To get the latest version and for technical support you can send EMAIL to
  261. your choice of the following addresses:
  262. rjc@snoopy.apana.org.au.
  263. Russell Coker @ 3:633/363.0 @ fidonet
  264.  
  265.     Or call my BBS directly on +61-3-739-7145.
  266.  
  267.     You can now login to my BBS via the Internet by using the VMODEM function
  268. that is built into Ray Gwinn's SIO drivers.  Use address multi.apana.org.au
  269. which is IP address 202.12.87.130 with the default VMODEM port.
  270.  
  271.   To get the absolutely latest version FREQ "TELDOR" from 3:633/363@fidonet,
  272. download it from files area OBBS in my BBS as the latest file that matches
  273. "TELDR" (do a locate to find it), or do an anonymous FTP from my Internet
  274. system (snoopy.apana.org.au).  Also many other sites have copies of my program,
  275. the systems hobbes.nmsu.edu and ftp-os2.cdrom.com get copies soon after release
  276. and they both have Internet links that are thousands of times faster than mine
  277. so you may prefer to FTP from them instead of from me.  But if you are paranoid
  278. about corrupt files or something then feel free to download it from
  279. snoopy.apana.org.au.  Snoopy is an Internet host that is totally administered
  280. by myself.
  281.    If you wish to logon to my BBS using the Internet (to avoid paying long
  282. distance phone charges if you don't live in the same city or country as me) you
  283. can login to multi.apana.org.au using either the Telnet or Vmodem protocols.
  284.    Also if you experience problems with this product and you are on the
  285. Internet then you can use either snoopy.apana.org.au or multi.apana.org.au as
  286. telnet targets for testing.  These are the systems that I use for testing
  287. Telnet Door during development so you can count on these working.
  288.  
  289.    I am currently running a mailing list for UUencoded copies of this program.
  290. This means that people who have Internet EMAIL addresses don't have to do
  291. anything to keep up to date with the very latest versions of my program, they
  292. can just automatically receive copies in their mail account without having to
  293. do anything.  If you are interested in this idea then just send me an EMAIL
  294. message to my Internet address and I'll put you on the list.
  295.